<?php
/**
 * PhpStorm.
 * User: Jay
 * Date: 2018/8/13
 */

namespace ServiceBundle\Document;


use RedUnicorn\Document\Document;

class AreaDocument extends Document
{
    public function add()
    {
        $this->setGroup('全局服务/地址信息服务');
        return parent::add();
    }

    public function setUrl($url)
    {
        return parent::setUrl('/service/area' . $url);
    }

    /**
     * @throws \Exception
     */
    public function areaAction()
    {
        $this->add()
            ->setTitle('全部的省市区数据')
            ->setUrl('/all')
            ->addParam('is_hierarchy', '是否层级化', 'boolean', true, 0, ' 0 否 1 是')
            ->generate();

        $this->add()
            ->setTitle('得到下辖省市区信息')
            ->setUrl('/subordination')
            ->addParam('area_id', '地址id', 'integer', true, 0, 'area_id为0的时候返回全部省的信息')
            ->generate();

        $this->add()
            ->setTitle('根据城市名称得到城市ID')
            ->setUrl('/getCityId')
            ->addParam('city_name', '城市名称')
            ->generate();

        $this->add()
            ->setTitle('得到全部的城市')
            ->setUrl('/getAllCity')
            ->addParam('sort', '是否按首字母分组归纳', 'boolean', true, 0 , ' 0 否 1 是')
            ->generate();
    }


}